Skip to content

DOC: closes gh6838. Breakout options.rst from basics.rst #7578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2014

Conversation

clham
Copy link
Contributor

@clham clham commented Jun 26, 2014

closes #6838.
closes #3104
Breakout "options" section for docs, heavily using info already in basics.rst. Expands examples, and turns describe_options into a table.

@jreback
Copy link
Contributor

jreback commented Jun 26, 2014

also their is a section in the FAQ which you can incorporate (or maybe just delete)

@jreback jreback added the Docs label Jun 26, 2014
@jreback jreback added this to the 0.14.1 milestone Jun 26, 2014
@@ -130,6 +130,7 @@ See the package overview for more detail about what's in the library.
reshaping
timeseries
visualization
options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this right after basics (before indexing)

@jreback
Copy link
Contributor

jreback commented Jun 26, 2014

I the top level you can render this and how it?

@clham
Copy link
Contributor Author

clham commented Jun 26, 2014

What is the best way to get the .html up here?

@jreback
Copy link
Contributor

jreback commented Jun 26, 2014

see here: #7398

You make a .png and then gh will show it

@clham
Copy link
Contributor Author

clham commented Jun 26, 2014

options and settings pandas 0 14 0-117-g8536e05 documentation

@jorisvandenbossche
Copy link
Member

Wonderfull!
I will only be able to give this a review beginning next week.

BTW, as an alternative to show the output, instead of a png, you can also push it to github pages. See eg https://github.com/jorisvandenbossche/example-pandas-docs (I pushed the relevant pages (+ the static folder for css) to a folder in that repo for each pr, and then we can look at it that way). Then you can just give that link, and update the content if changes are made. (But do as you like!)


.. _ref-repr-control:

How do I control the way my DataFrame is displayed?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You removed the content in faq.rst, but is this all included in the new page?

And, maybe you could leave the question in the FAQ, but refer to the new docs page as the answer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content is in there, with examples given for large_repr , expand_repr, and max_rows. The other items are much more clearly described in the table at the bottom. I'm happy to put the FAQ question back in, however, with this iteration of the docs, it should be much easier to find.

@clham
Copy link
Contributor Author

clham commented Jul 1, 2014

options and settings -2

@asobrien
Copy link
Contributor

asobrien commented Jul 1, 2014

I'm seeing the same Travis-CI build errors for pull request #7619. These build errors don't seem to be related to the pull requests.


with pd.option_context("display.max_rows",10,"display.max_columns", 5):
print(pd.get_option("display.max_rows"))
print(pd.get_option("display.max_columns"))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be not working in your example output (I mean the indentation of this line is lost -> not anymore in with context)

@jorisvandenbossche
Copy link
Member

@clham Do you have time the coming days to process the comments?

@clham
Copy link
Contributor Author

clham commented Jul 5, 2014

Yes. Sorry about dropping this, I started a new job this week and have
been slammed.
On Jul 5, 2014 9:51 AM, "Joris Van den Bossche" [email protected]
wrote:

@clham https://github.com/clham Do you have time the coming days to
process the comments?


Reply to this email directly or view it on GitHub
#7578 (comment).

@jorisvandenbossche
Copy link
Member

No problem, let know when you find some time to update.
Pushing this to 0.15 (as it is not critical for the release)

@jorisvandenbossche jorisvandenbossche added this to the 0.15.0 milestone Jul 6, 2014
@jorisvandenbossche jorisvandenbossche removed this from the 0.14.1 milestone Jul 6, 2014
@clham
Copy link
Contributor Author

clham commented Jul 6, 2014

options and settings -3

@jreback
Copy link
Contributor

jreback commented Jul 6, 2014

looking sexy :)

@jreback jreback modified the milestones: 0.15.0, 0.15.1 Jul 6, 2014
@jorisvandenbossche
Copy link
Member

@clham Really thanks a lot!
Looking very good, so let's merge this, and we can always correct or update later if there are some more issues.

jorisvandenbossche added a commit that referenced this pull request Jul 7, 2014
DOC: closes gh6838. Breakout options.rst from basics.rst
@jorisvandenbossche jorisvandenbossche merged commit 4a27e63 into pandas-dev:master Jul 7, 2014
@clham clham deleted the 6838_set_option_doc branch January 17, 2015 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: set_option docstring DOC: consolidate docs for console formatting / options sections
4 participants